home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / umich / tex / tex31 / manpages.lzh / WEAVE.1 < prev   
Text File  |  1990-12-03  |  4KB  |  133 lines
  1.  
  2.  
  3.  
  4.      WEB(1)            UNIX 5.3 (5/27/90)            WEB(1)
  5.  
  6.  
  7.  
  8.      NAME
  9.       tangle, weave    - translate WEB    to Pascal and/or TeX
  10.  
  11.      SYNOPSIS
  12.       tangle webfile[.web] [changefile[.ch]]
  13.       weave    [-x] webfile[.web] [changefile[.ch]]
  14.  
  15.      DESCRIPTION
  16.       The tangle program converts a    WEB source document into a
  17.       Pascal program that may be compiled in the usual way with
  18.       the on-line Pascal compiler (e.g., pc(1)).  The output file
  19.       is all in lower case and packed into lines of    72 characters
  20.       or less, with    the only concession to readability being the
  21.       termination of lines at semicolons when this can be done
  22.       conveniently.
  23.  
  24.       The WEB language allows you to prepare a single document
  25.       containing all the information that is needed    both to
  26.       produce a compilable Pascal program and to produce a well-
  27.       formatted document describing    the program in as much detail
  28.       as the writer    may desire.  The user of WEB must be familiar
  29.       with both TeX    and Pascal.  WEB also provides a relatively
  30.       simple, although adequate, macro facility that permits a
  31.       Pascal program to be written in small    easily-understood
  32.       modules.
  33.  
  34.       The command line should have either one or two names on it.
  35.       The first is taken as    the WEB    file (and .web is added    if
  36.       there    is no extension).  If there is another name, it    is a
  37.       change file (and .ch is added    if there is no extension).
  38.       The change file overrides parts of the WEB file, as
  39.       described in the WEB system documentation.
  40.  
  41.       The output files are a Pascal    file and a string pool file,
  42.       whose    names are formed by adding .p and .pool    respectively
  43.       to the root of the WEB file name.
  44.  
  45.       The weave program is used to create a    TeX file for viewing
  46.       the WEB program.  It takes appropriate care of typographic
  47.       details like page layout and the use of indentation,
  48.       italics, boldface, etc., and it supplies extensive cross-
  49.       index    information that it gathers automatically.  The
  50.       command line arguments are the same as for tangle except for
  51.       the option: -x says to omit the index, module    name list, and
  52.       table    of contents pages.  (A CONTENTS.tex file will still be
  53.       written when the TeX file is processed, however, unless some
  54.       macros in webmac.tex are redefined.)
  55.  
  56.       The output TeX file name is formed by    adding .tex to the
  57.       root of the WEB file name.
  58.  
  59.       There    are several macros that    probably should    be redefined
  60.  
  61.  
  62.  
  63.      Page 1                         (printed 12/3/90)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      WEB(1)            UNIX 5.3 (5/27/90)            WEB(1)
  71.  
  72.  
  73.  
  74.       by the programmer at the beginning of    the WEB    file.  It is a
  75.       good idea to set \title to the name of the program.  And, to
  76.       cause    output of only changed modules,    one can    say
  77.       \let\maybe=\iffalse (usually as the first change in the
  78.       change file).
  79.  
  80.      FILES
  81.       /usr/local/lib/tex/macros/webmac.tex     TeX macros used by
  82.       weave    output.
  83.  
  84.      SEE ALSO
  85.       The WEB System of Structured Documentation and
  86.       LiterateProgramming, by D.E. Knuth.
  87.       WeavingaProgram, by Wayne Sewell
  88.       tex(1), pc(1)
  89.       pxp(1) (for formatting tangle    output when debugging)
  90.       TeX: The Program and METAFONT: The Program,volumesBandD
  91.       Computers and    Typesetting series, published by Addison-
  92.       Wesley, are by far the largest extant    examples of WEB
  93.       programs.
  94.  
  95.      AUTHORS
  96.       WEB was designed by Donald E.    Knuth, based on    an earlier
  97.       system called    DOC (implemented by Ignacio Zabala).  The
  98.       tangle and weave programs are    themselves written in WEB. The
  99.       system was originally    ported to Unix at Stanford by Howard
  100.       Trickey, and at Cornell by Pavel Curtis.
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                         (printed 12/3/90)
  130.  
  131.  
  132.  
  133.